home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / XmeTransferAddDoneProc.z / XmeTransferAddDoneProc
Encoding:
Text File  |  2002-10-03  |  10.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmeeeeTTTTrrrraaaannnnssssffffeeeerrrrAAAAddddddddDDDDoooonnnneeeePPPPrrrroooocccc((((3333XXXX))))UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVVXXXXmmmmeeeeTTTTrrrraaaannnnssssffffeeeerrrrAAAAddddddddDDDDoooonnnneeeePPPPrrrroooocccc((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmeeeeTTTTrrrraaaannnnssssffffeeeerrrrAAAAddddddddDDDDoooonnnneeeePPPPrrrroooocccc - A toolkit function that establishes
  10.           a procedure to be called when data transfer is complete
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/TransferP.h>
  14.           vvvvooooiiiidddd XXXXmmmmeeeeTTTTrrrraaaannnnssssffffeeeerrrrAAAAddddddddDDDDoooonnnneeeePPPPrrrroooocccc(
  15.           XXXXttttPPPPooooiiiinnnntttteeeerrrr ttttrrrraaaannnnssssffffeeeerrrr____iiiidddd,
  16.           XXXXmmmmSSSSeeeelllleeeeccccttttiiiioooonnnnFFFFiiiinnnniiiisssshhhheeeeddddPPPPrrrroooocccc ddddoooonnnneeee____pppprrrroooocccc);
  17.  
  18.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  19.           This page documents Motif 2.1.
  20.  
  21.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  22.           XXXXmmmmeeeeTTTTrrrraaaannnnssssffffeeeerrrrAAAAddddddddDDDDoooonnnneeeePPPPrrrroooocccc establishes a procedure to be called
  23.           by the toolkit when a data transfer operation is complete.
  24.           This routine can be called from an
  25.           XXXXmmmmNNNNddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkkprocedure or from any function called
  26.           as a result, including the following:
  27.  
  28.              +o  From the selection procedures called as a result of
  29.                 calls to _X_m_T_r_a_n_s_f_e_r_V_a_l_u_e,
  30.  
  31.              +o  From a ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnPPPPrrrroooocccc trait method; ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnPPPPrrrroooocccc
  32.                 is one of the trait methods of the _X_m_Q_T_t_r_a_n_s_f_e_r trait.
  33.  
  34.           If more than one such procedure has been established for a
  35.           given transfer operation, all procedures are called when the
  36.           transfer operation is complete.
  37.  
  38.           The _d_o_n_e__p_r_o_c argument holds a function of type
  39.           XXXXmmmmSSSSeeeelllleeeeccccttttiiiioooonnnnFFFFiiiinnnniiiisssshhhheeeeddddPPPPrrrroooocccc, which has the following definition:
  40.  
  41.           vvvvooooiiiidddd ((((**** XXXXmmmmSSSSeeeelllleeeeccccttttiiiioooonnnnFFFFiiiinnnniiiisssshhhheeeeddddPPPPrrrroooocccc))))(
  42.           WWWWiiiiddddggggeeeetttt wwwwiiiiddddggggeeeetttt,
  43.           XXXXttttEEEEnnnnuuuummmm ooooppppeeeerrrraaaattttiiiioooonnnn,
  44.           XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeeeCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt ****ccccaaaallllllll____ddddaaaattttaaaa);
  45.  
  46.           _w_i_d_g_e_t    Specifies the widget that requested the
  47.                     conversion.
  48.  
  49.           _o_p_e_r_a_t_i_o_n Specifies the transfer operation.  Possible values
  50.                     are XXXXmmmmMMMMOOOOVVVVEEEE, XXXXmmmmCCCCOOOOPPPPYYYY, XXXXmmmmLLLLIIIINNNNKKKK, and XXXXmmmmOOOOTTTTHHHHEEEERRRR.
  51.  
  52.           _c_a_l_l__d_a_t_a Specifies a pointer to an
  53.                     XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeeeCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt structure containing
  54.                     information about the status of the transfer.
  55.  
  56.           XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeeeCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt is defined as follows:
  57.  
  58.           typedef struct {
  59.                   int     _r_e_a_s_o_n;
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmeeeeTTTTrrrraaaannnnssssffffeeeerrrrAAAAddddddddDDDDoooonnnneeeePPPPrrrroooocccc((((3333XXXX))))UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVVXXXXmmmmeeeeTTTTrrrraaaannnnssssffffeeeerrrrAAAAddddddddDDDDoooonnnneeeePPPPrrrroooocccc((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                   XEvent  *_e_v_e_n_t;
  75.                   Atom    _s_e_l_e_c_t_i_o_n;
  76.                   XtPointer       _t_r_a_n_s_f_e_r__i_d;
  77.                   XmTransferStatus        _s_t_a_t_u_s;
  78.                   XtPointer       _c_l_i_e_n_t__d_a_t_a;
  79.           } XmTransferDoneCallbackStruct;
  80.  
  81.           _r_e_a_s_o_n    Indicates why the callback was invoked.
  82.  
  83.           _e_v_e_n_t     Points to the _X_E_v_e_n_t that triggered the callback.
  84.                     It can be _N_U_L_L.
  85.  
  86.           _s_e_l_e_c_t_i_o_n Indicates the selection being converted.
  87.  
  88.           _t_r_a_n_s_f_e_r__i_d
  89.                     Specifies a unique indentifier for the data
  90.                     transfer operation.
  91.  
  92.           _s_t_a_t_u_s    Indicates whether or not the transfer completed
  93.                     successfully.  Following are the possible values:
  94.  
  95.                     XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____DDDDOOOONNNNEEEE____SSSSUUUUCCCCCCCCEEEEEEEEDDDD
  96.                               The transfer completed successfully.
  97.  
  98.                     XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____DDDDOOOONNNNEEEE____FFFFAAAAIIIILLLL
  99.                               The transfer did not complete
  100.                               successfully.
  101.  
  102.           _c_l_i_e_n_t__d_a_t_a
  103.                     Specifies data to be passed to the callback
  104.                     procedure.
  105.  
  106.           The XXXXmmmmeeeeTTTTrrrraaaannnnssssffffeeeerrrrAAAAddddddddDDDDoooonnnneeeePPPPrrrroooocccc routine takes the following
  107.           arguments:
  108.  
  109.           _t_r_a_n_s_f_e_r__i_d
  110.                     Specifies a unique indentifier for the data
  111.                     transfer operation.  The value must be the same as
  112.                     the value of the _t_r_a_n_s_f_e_r__i_d member of the
  113.                     XXXXmmmmDDDDeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt passed to the
  114.                     XXXXmmmmNNNNddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkk procedure or the
  115.                     ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnPPPPrrrroooocccc_X_m_Q_T_t_r_a_n_s_f_e_r trait method.
  116.  
  117.           _d_o_n_e__p_r_o_c Specifies a procedure to be called when the data
  118.                     transfer is complete.  The procedure is of type
  119.                     XXXXmmmmSSSSeeeelllleeeeccccttttiiiioooonnnnFFFFiiiinnnniiiisssshhhheeeeddddPPPPrrrroooocccc.
  120.  
  121.      RRRREEEELLLLAAAATTTTEEEEDDDD
  122.           XXXXmmmmQQQQTTTTttttrrrraaaannnnssssffffeeeerrrr(3), XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeee(3), XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee(3),
  123.           XXXXmmmmeeeeCCCClllliiiippppbbbbooooaaaarrrrddddSSSSiiiinnnnkkkk(3), XXXXmmmmeeeeCCCClllliiiippppbbbbooooaaaarrrrddddSSSSoooouuuurrrrcccceeee(3),
  124.           XXXXmmmmeeeeCCCCoooonnnnvvvveeeerrrrttttMMMMeeeerrrrggggeeee(3), XXXXmmmmeeeeDDDDrrrraaaaggggSSSSoooouuuurrrrcccceeee(3), XXXXmmmmeeeeDDDDrrrrooooppppSSSSiiiinnnnkkkk(3),
  125.           XXXXmmmmeeeeGGGGeeeettttEEEEnnnnccccooooddddiiiinnnnggggAAAAttttoooommmm(3), XXXXmmmmeeeePPPPrrrriiiimmmmaaaarrrryyyySSSSiiiinnnnkkkk(3),
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmeeeeTTTTrrrraaaannnnssssffffeeeerrrrAAAAddddddddDDDDoooonnnneeeePPPPrrrroooocccc((((3333XXXX))))UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVVXXXXmmmmeeeeTTTTrrrraaaannnnssssffffeeeerrrrAAAAddddddddDDDDoooonnnneeeePPPPrrrroooocccc((((3333XXXX))))
  137.  
  138.  
  139.  
  140.           XXXXmmmmeeeePPPPrrrriiiimmmmaaaarrrryyyySSSSoooouuuurrrrcccceeee(3), XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyySSSSiiiinnnnkkkk(3),
  141.           XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyySSSSoooouuuurrrrcccceeee(3), XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr(3),
  142.           XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt(3), and XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddTTTTaaaarrrrggggeeeettttssss(3).
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.